API Console

This tool lets you manage values of API variables.

There are four possibilities how to launch the API console window:

Select the File > API console main menu item – only system API variables are shown.
Select the Accounts > API console main menu item – API variables of the selected domain/account are shown.
Right-click a domain name and select the API console item – domain API variables are shown.
Right-click a single account (specific user, group, mailing list, etc.) and select the API console item – account API variables are shown.

Figure. API console view.

Field	Description
Filter	Write an expression (or a part of it) you want to search for. You can search for values from all three columns. To reveal all variables, clear the field and press Enter.
Export	Click the button to export (import respectively) API variables values. Usual Save As (Open respectively) dialog is shown. Recommended file formats are .cvs and .txt, but other ones are also possible. Note: When filtering performed, only shown variables are exported.
Import	Import

Field

Description

Filter

Write an expression (or a part of it) you want to search for. You can search for values from all three columns.

To reveal all variables, clear the field and press Enter.

Export

Click the button to export (import respectively) API variables values. Usual Save As (Open respectively) dialog is shown.

Recommended file formats are .cvs and .txt, but other ones are also possible.

Note: When filtering performed, only shown variables are exported.

Import

Right-click the selected variable to manage it.

Figure. Toggle option.

Figure. Modify option.

Item	Description
Toggle	Applies to boolean values. Toggles them – true/false.
Modify	Applies to string values and integer ones. Dialog for change performance is shown.
Copy Name/Value	Click the item to copy the name of the selected variable (value respectively) into your clipboard.

Note: Some values are not changeable – Modify/Toggle items are not enabled. These values are set within installation (version, timezone, ...) or determined from the current state (mailboxsize) etc.

Note: When seeing boolean values, they represent either a 1 or 0. If set to 1, it means the option is enabled and 0 means disabled.

Note: The API console does show exact variable names. To obtain its exact name, right-click a variable within the console and select the Copy Name item (or search for this variable within the apiconst.pas file ({install_dir}/api/delphi/)).